SoundComponentSetInfo

SoundComponentSetInfo
Header:	Sound.h		Carbon status:	Supported

Modifies settings of your component. A sound component must implement the SoundComponentSetInfo function.

ComponentResult SoundComponentSetInfo (
    ComponentInstance ti, 
    SoundSource sourceID, 
    OSType selector, 
    void *infoPtr
);

Parameter descriptions

ti: A component instance that identifies your sound component.
sourceID: A source ID for a source component chain.
selector: A sound component information selector. See “Audio Data Types” for a description of the available selectors.
infoPtr: A pointer to the information your component is to use to modify its settings. If the information occupies 4 or fewer bytes, however, this parameter contains the information itself, not the address of the information.

function result: Your SoundComponentSetInfo function should return noErr if successful or an appropriate result code otherwise.

DISCUSSION

Your SoundComponentSetInfo function is called by the Sound Manager to set one of the settings for your component, as specified by the selector parameter. If the information associated with that selector occupies 4 or fewer bytes, it is passed on the stack, in the infoPtr parameter itself. Otherwise, the infoPtr parameter is a pointer to a structure of type SoundInfoList. See the description of SoundComponentGetInfo for more information about the SoundInfoList structure.

If your component cannot modify the settings specified by the selector parameter, it should pass the selector to its source component.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.